Implement Local Log push and SQL Execution Support by abdotop · Pull Request #9 · 01-edu/framework

abdotop · 2026-01-05T09:38:51Z

No description provided.

…ed CORS for remote logging.

Copilot

Pull request overview

This PR implements integration with external DevTools for local development and production monitoring. It adds support for remote log pushing, SQL query execution for debugging, and DevTools connection handshake mechanisms.

Added new system routes for API documentation (GET/api/doc), SQL execution (POST/api/execute-sql), and DevTools connection (POST/api/connect-devtools)
Implemented CORS support to allow DevTools running on different origins to communicate with the API
Extended logging to support remote batch sending in both development and production environments with dynamic token configuration

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 29 comments.

Show a summary per file

File	Description
types/router.d.ts	Added `ReservedRoutes` type to mark system routes as deprecated when overridden
db/mod.ts	Extracted `Sql` type definition for reuse in other modules
api/server.ts	Added CORS headers handling for DevTools integration in development mode
api/router.ts	Modified signature to accept `RouterOptions` and automatically register system routes
api/log.ts	Extended logger to support dynamic token updates and remote log batching in dev mode
api/env.ts	Renamed `DEVTOOL_TOKEN` to `DEVTOOL_REPORT_TOKEN` and added `DEVTOOL_ACCESS_TOKEN`
api/doc.ts	New file implementing automatic API documentation generation from route definitions
api/dev.ts	New file implementing SQL execution and DevTools handshake routes
README.md	Updated documentation to reflect renamed environment variables
.github/workflows/ga-npm-publish.yml	Changed quote style from double to single quotes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-05T09:44:17Z

api/router.ts

 ): (ctx: RequestContext) => Awaitable<Response> => {
  const routeMaps: Record<string, Route> = Object.create(null)

+  if (!defs['POST/api/execute-sql']) {


The route is being added even if SQL is not provided, which will result in the route returning NotImplemented responses. Consider only adding the route when SQL is actually configured to avoid exposing a non-functional endpoint.

Suggested change

if (!defs['POST/api/execute-sql']) {

if (sql && !defs['POST/api/execute-sql']) {

Copilot · 2026-01-05T09:44:18Z

api/server.ts

+     res.headers.set('Access-Control-Allow-Origin', origin)
+     res.headers.set('Access-Control-Allow-Methods', 'POST, OPTIONS')
+     res.headers.set('Access-Control-Allow-Headers', 'Authorization, Content-Type')
+     res.headers.set('Access-Control-Allow-Credentials', 'true')


These lines have inconsistent indentation (extra leading spaces) compared to the rest of the function. The indentation should match the surrounding code.

Copilot · 2026-01-05T09:44:18Z

api/server.ts

+        const res = respond.NoContent()
+        return addCorsHeaders(res, origin)


This line has inconsistent indentation (extra leading spaces). The indentation should match the surrounding code.

Suggested change

const res = respond.NoContent()

return addCorsHeaders(res, origin)

const res = respond.NoContent()

return addCorsHeaders(res, origin)

Copilot · 2026-01-05T09:44:19Z

api/log.ts

+type LoggerOptions = 
+ {


The type definition spans multiple lines with unusual formatting. The opening brace should be on the same line as the type name for consistency with TypeScript conventions.

Suggested change

type LoggerOptions =

{

type LoggerOptions = {

Copilot · 2026-01-05T09:44:19Z

db/mod.ts

+export type Sql = <
+  T extends { [k in string]: unknown } | undefined,
+  P extends BindValue | BindParameters | undefined,
+>(sqlArr: TemplateStringsArray, ...vars: unknown[]) => {
+  get: (params?: P) => T | undefined
+  all: (params?: P) => T[]
+  run: (params?: P) => void
+  value: (params?: P) => T[keyof T][] | undefined
+}


The type definition allows T to be undefined, but the return types don't properly handle this case. For example, value: (params?: P) => T[keyof T][] | undefined would fail at compile time if T is undefined because undefined has no keys. The type constraint should either exclude undefined or the return types should be adjusted.

Copilot · 2026-01-05T09:44:25Z

.github/workflows/ga-npm-publish.yml

      - name: 🟢 Update node
        uses: actions/setup-node@v6
-        with: { node-version: 24, registry-url: "https://registry.npmjs.org" }
+        with: { node-version: 24, registry-url: 'https://registry.npmjs.org' }


The quote style was changed from double quotes to single quotes. While this change is cosmetic, it should be consistent with the project's style guidelines. Ensure this aligns with the project's formatting standards.

Suggested change

with: { node-version: 24, registry-url: 'https://registry.npmjs.org' }

with: { node-version: 24, registry-url: "https://registry.npmjs.org" }

Copilot · 2026-01-05T09:44:25Z

api/server.ts

+     // Dev convenience for local devtools development
+     res.headers.set('Access-Control-Allow-Origin', origin)
+     res.headers.set('Access-Control-Allow-Methods', 'POST, OPTIONS')
+     res.headers.set('Access-Control-Allow-Headers', 'Authorization, Content-Type')
+     res.headers.set('Access-Control-Allow-Credentials', 'true')


The comment mentions "Dev convenience for local devtools development" but uses inconsistent indentation (extra space before the comment). This should align with the surrounding code indentation.

Suggested change

// Dev convenience for local devtools development

res.headers.set('Access-Control-Allow-Origin', origin)

res.headers.set('Access-Control-Allow-Methods', 'POST, OPTIONS')

res.headers.set('Access-Control-Allow-Headers', 'Authorization, Content-Type')

res.headers.set('Access-Control-Allow-Credentials', 'true')

// Dev convenience for local devtools development

res.headers.set('Access-Control-Allow-Origin', origin)

res.headers.set('Access-Control-Allow-Methods', 'POST, OPTIONS')

res.headers.set('Access-Control-Allow-Headers', 'Authorization, Content-Type')

res.headers.set('Access-Control-Allow-Credentials', 'true')

Copilot · 2026-01-05T09:44:26Z

api/log.ts

+

There is trailing whitespace at the end of this line. This should be removed.

Suggested change

Copilot · 2026-01-05T09:44:26Z

api/log.ts


      const ev = `${makePrettyTimestamp(level, event)} ${callChain}`.trim()
      props ? console[level](ev, props) : console[level](ev)
+


There is trailing whitespace at the end of this line. This should be removed.

Suggested change

Copilot · 2026-01-05T09:44:26Z

api/log.ts

+  // @ts-ignore: Attach hidden method for dev tools
+  globalThis.__DEVTOOLS_SET_TOKEN__ = setToken


Attaching a hidden global method via globalThis creates a non-standard API surface that bypasses normal TypeScript type checking. This pattern makes the code harder to maintain and test. Consider using a more explicit dependency injection pattern or a proper configuration mechanism.

abdotop added 3 commits December 21, 2025 12:11

feat: add developer access authorization and SQL execution route

f32aee8

feat: add API documentation generation and route support

7dcc00d

feat: Add DevTools handshake route, dynamic logging token, and enhanc…

1d2b88a

…ed CORS for remote logging.

Copilot AI review requested due to automatic review settings January 5, 2026 09:38

abdotop linked an issue Jan 5, 2026 that may be closed by this pull request

[Feat] Implement Local Log push and SQL Execution Support #8

Open

Copilot started reviewing on behalf of abdotop January 5, 2026 09:39 View session

Copilot AI reviewed Jan 5, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Local Log push and SQL Execution Support#9

Implement Local Log push and SQL Execution Support#9
abdotop wants to merge 3 commits intomasterfrom
8-feat-implement-local-log-push-and-sql-execution-support

abdotop commented Jan 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Copilot AI Jan 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	if (!defs['POST/api/execute-sql']) {
	if (sql && !defs['POST/api/execute-sql']) {

		const res = respond.NoContent()
		return addCorsHeaders(res, origin)

	with: { node-version: 24, registry-url: 'https://registry.npmjs.org' }
	with: { node-version: 24, registry-url: "https://registry.npmjs.org" }


		const ev = `${makePrettyTimestamp(level, event)} ${callChain}`.trim()
		props ? console[level](ev, props) : console[level](ev)

		// @ts-ignore: Attach hidden method for dev tools
		globalThis.__DEVTOOLS_SET_TOKEN__ = setToken

Conversation

abdotop commented Jan 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant